/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.expression.function;

import org.antlr.v4.runtime.tree.TerminalNode;
import org.hisp.dhis.antlr.ParserExceptionWithoutContext;
import org.hisp.dhis.organisationunit.OrganisationUnit;
import org.hisp.dhis.parser.expression.CommonExpressionVisitor;
import org.hisp.dhis.parser.expression.ExpressionItem;
import org.hisp.dhis.parser.expression.antlr.ExpressionParser;

/**
 * Function orgUnit.ancestor
 *
 * <p>Is current orgUnit a descendant of one of the ancestors?
 *
 * @author Jim Grace
 */
public class FunctionOrgUnitAncestor implements ExpressionItem {
  @Override
  public Object getDescription(ExpressionParser.ExprContext ctx, CommonExpressionVisitor visitor) {
    for (TerminalNode uid : ctx.UID()) {
      OrganisationUnit orgUnit =
          visitor.getIdObjectManager().get(OrganisationUnit.class, uid.getText());

      if (orgUnit == null) {
        throw new ParserExceptionWithoutContext(
            "No organization unit defined for " + uid.getText());
      }

      visitor.getItemDescriptions().put(uid.getText(), orgUnit.getDisplayName());
    }

    return false;
  }

  @Override
  public Object evaluate(ExpressionParser.ExprContext ctx, CommonExpressionVisitor visitor) {
    OrganisationUnit orgUnit = visitor.getParams().getOrgUnit();

    if (orgUnit != null) {
      for (TerminalNode uid : ctx.UID()) {
        if (orgUnit.getStoredPath().contains(uid.getText() + "/")) {
          return true;
        }
      }
    }

    return false;
  }
}
